| name | skill-{{cookiecutter.project_slug}} |
| description | [object Object] |
When to use
- When you need to use {{cookiecutter.project_slug}} CLI tool
- When you need comprehensive guidance on CLI commands
- When you need examples and troubleshooting
{{cookiecutter.project_name}} Skill
Purpose
This skill provides access to the {{cookiecutter.project_slug}} CLI tool. {{cookiecutter.project_description}}.
When to Use This Skill
Use this skill when:
- You need to understand how to use {{cookiecutter.project_slug}}
- You need comprehensive examples and patterns
- You need troubleshooting guidance
Do NOT use this skill for:
- Tasks unrelated to {{cookiecutter.project_slug}}
- Quick syntax lookups (use slash commands instead)
CLI Tool: {{cookiecutter.project_slug}}
The {{cookiecutter.project_slug}} is a command-line interface tool that {{cookiecutter.project_description}}.
Installation
# Clone and install
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.git
cd {{cookiecutter.project_slug}}
uv tool install .
Prerequisites
- Python 3.14+
- uv package manager
Quick Start
# Example 1: Basic usage
{{cookiecutter.project_slug}} --help
# Example 2: Show version
{{cookiecutter.project_slug}} --version
Progressive Disclosure
📖 Core Commands (Click to expand)
help - Show Help Information
Display help information for CLI commands.
Usage:
{{cookiecutter.project_slug}} --help
{{cookiecutter.project_slug}} COMMAND --help
Examples:
# General help
{{cookiecutter.project_slug}} --help
# Command help
{{cookiecutter.project_slug}} command --help
# Version info
{{cookiecutter.project_slug}} --version
⚙️ Advanced Features (Click to expand)
Multi-Level Verbosity Logging
Control logging detail with progressive verbosity levels. All logs output to stderr.
Logging Levels:
| Flag | Level | Output | Use Case |
|---|---|---|---|
| (none) | WARNING | Errors and warnings only | Production, quiet mode |
-v |
INFO | + High-level operations | Normal debugging |
-vv |
DEBUG | + Detailed info, full tracebacks | Development, troubleshooting |
-vvv |
TRACE | + Library internals | Deep debugging |
Examples:
# INFO level - see operations
{{cookiecutter.project_slug}} command -v
# DEBUG level - see detailed info
{{cookiecutter.project_slug}} command -vv
# TRACE level - see all internals
{{cookiecutter.project_slug}} command -vvv
Shell Completion
Native shell completion for bash, zsh, and fish.
Installation:
# Bash (add to ~/.bashrc)
eval "$({{cookiecutter.project_slug}} completion bash)"
# Zsh (add to ~/.zshrc)
eval "$({{cookiecutter.project_slug}} completion zsh)"
# Fish (save to completions)
{{cookiecutter.project_slug}} completion fish > ~/.config/fish/completions/{{cookiecutter.project_slug}}.fish
Pipeline Composition
Compose commands with Unix pipes for powerful workflows.
Examples:
# Example pipeline workflows will be added when CLI commands are implemented
{{cookiecutter.project_slug}} command --json | jq '.'
🔧 Troubleshooting (Click to expand)
Common Issues
Issue: Command not found
# Verify installation
{{cookiecutter.project_slug}} --version
# Reinstall if needed
cd {{cookiecutter.project_slug}}
uv tool install . --reinstall
Issue: General errors
- Try with verbose flag:
-vvto see detailed error information - Check that all prerequisites are installed
- Ensure you're using Python 3.14+
Getting Help
# Show help
{{cookiecutter.project_slug}} --help
# Command-specific help
{{cookiecutter.project_slug}} COMMAND --help
Exit Codes
0: Success1: Client error (invalid arguments, validation failed)2: Server error (API error, network issue)3: Network error (connection failed, timeout)
Output Formats
Default Output:
- Human-readable formatted output
- Varies by command
JSON Output (--json flag):
- Machine-readable structured data
- Perfect for pipelines and processing
- Available on commands that support structured output
Best Practices
- Use verbosity progressively: Start with
-v, increase to-vv/-vvvonly if needed - Check help first: Use
--helpto understand command options - Leverage shell completion: Install completion for better CLI experience
Resources
- GitHub: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
- Python Package Index: https://pypi.org/project/{{cookiecutter.project_slug}}/
- Documentation: